تمامی توسعه دهندگان و برنامه نویس هایی که روی پروژه های بزرگ کار کرده اند، از اهمیت کامنت (توضیح = comment) گذاری هنگام کدنویسی واقف هستند. زمانی که روی یک اپلیکشن کار می کنید، به مرور با افزایش امکانات، پیچیدگی آن نیز افزایش می یابد. ممکن است در کد بارها و بارها به فانکشن ها یا متغیرهای خاصی ارجاع داده شود و از آنها اطلاعات یا مقادیر خاصی گرفته شود. آیا می دانید، اگر پس از مدتی به کد مراجعه کنید، چیز زیادی از چگونگی کارکرد آن به خاطر نخواهید داشت؟ آیا می دانید که مجبورید ساعت ها صرف کنید تا به یاد بیاورید هر کدام از قسمت های کد چه کار می کند؟ شاید تعجب کنید اما این یک واقعیت است.

علاوه بر مورد بالا، کامنت گذاری هنگام کار گروهی اهمیتی به مراتب بالاتر دارد و از واجبات است. اما بسیاری توسعه دهندگان از چگونگی این کار اطلاع کافی ندارند.
روش های استاندارد و الگوهای کامنت گذاری بین دولوپرهای مختلف متفاوت است، اما به عنوان یک اصل کلی باید آنها تمیز و خوانا باشند تا به خوبی قسمت های گیج کننده کد را توضیح دهند.

در اینجا قصد داریم راجع به بعضی اصول کامنت گذاری صحبت کنیم که با خواندن آنها قطعا ایده های بهتری برای توضیح جزییات کد در پروژه ها، به ذهن تان می رسد. علاوه بر این تعدادی مثال نیز در لابه لای مطلب آورده شده تا درک بهتری از بحث داشته باشید. امید است از این مطلب عنوان یک سکوی پرتاب برای ورود به دنیای کامنت گذاران خوب، استفاده کنید.

نظرات شما عزیزان:

نام :

آدرس ایمیل:

وب سایت/بلاگ :

متن پیام:

نظر خصوصی

 کد را وارد نمایید:

 

 

 

عکس شما

آپلود عکس دلخواه: